Improve documentation and behaviour of mprocs - #58718
Merged
Merged
Conversation
potiuk
requested review from
amoghrajesh,
ashb,
bugraoz93,
gopidesupavan,
jason810496,
jscheffl and
kaxil
as code owners
November 26, 2025 11:42
potiuk
force-pushed
the
improve-mprocs-docs-and-generation
branch
from
November 26, 2025 11:43
5f709be to
762befa
Compare
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found
potiuk
force-pushed
the
improve-mprocs-docs-and-generation
branch
from
November 26, 2025 15:15
762befa to
651f470
Compare
Member
Author
|
Added workarounds/solution for iTerm2 issues. |
jscheffl
approved these changes
Nov 26, 2025
amoghrajesh
approved these changes
Nov 27, 2025
choo121600
approved these changes
Nov 27, 2025
github-actions Bot
pushed a commit
that referenced
this pull request
Nov 28, 2025
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found (cherry picked from commit d1bd555) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
Contributor
Backport successfully created: v3-1-test
|
potiuk
added a commit
that referenced
this pull request
Nov 28, 2025
…58798) The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found (cherry picked from commit d1bd555) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
ephraimbuddy
pushed a commit
that referenced
this pull request
Dec 3, 2025
…58798) The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found (cherry picked from commit d1bd555) Co-authored-by: Jarek Potiuk <jarek@potiuk.com>
RoyLee1224
pushed a commit
to RoyLee1224/airflow
that referenced
this pull request
Dec 3, 2025
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found
Copilot AI
pushed a commit
to jason810496/airflow
that referenced
this pull request
Dec 5, 2025
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found
itayweb
pushed a commit
to itayweb/airflow
that referenced
this pull request
Dec 6, 2025
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found
2 tasks
Subham-KRLX
pushed a commit
to Subham-KRLX/airflow
that referenced
this pull request
Mar 4, 2026
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily. This is all corrected here: * README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty * Hallucinated keybindings were corrected * basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file * we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment * removed replacement of local executor that is not needed any more also in run_mprocs * added some non-obvious but useful key bindings in the guide * the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze. * there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The AI-generated documentation had some hallucinations and had a bit of duplication and chattines. Also it was not clear you can also easily run mprocs outside of breeze in regular terminal (you can !) and how to do it easily.
This is all corrected here:
README.md is removed (most of the content was in QUICK REFERENCE or was just too chatty
Hallucinated keybindings were corrected
basic.yaml is now simply mprocs.yml so that you can use it directly in the contributing-docs/mprocs folder without specifying config file
we are using now uv to run generate_mprocs_config.py and it has inline requirements specified - making it easily usable outside of breeze environment
removed replacement of local executor that is not needed any more also in run_mprocs
added some non-obvious but useful key bindings in the guide
the generated mprocs.yaml is now created in /files when run with start-airflow which makes it directly usable outside of Breeze.
there are some caveats of mprocs working with iTerm2 on MacOS, this change documents workaround/solution needed to work with mprocs until better solutions are found
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in airflow-core/newsfragments.